Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ci(e2e): use !cancelled() rather than always() #3229

Merged
merged 2 commits into from
Dec 2, 2024
Merged

ci(e2e): use !cancelled() rather than always() #3229

merged 2 commits into from
Dec 2, 2024

Conversation

gartnera
Copy link
Member

@gartnera gartnera commented Nov 27, 2024 •
edited by coderabbitai bot
Loading

It is suggested in the docs to use this: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/evaluate-expressions-in-workflows-and-actions#always

This should make concurrency cancellations work again

Summary by CodeRabbit

  • Chores
    • Improved the control flow of end-to-end testing workflows to prevent execution if cancelled.
    • Enhanced logic for determining which tests to run based on workflow trigger conditions.

@gartnera gartnera added the no-changelog Skip changelog CI check label Nov 27, 2024
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 27, 2024 •
edited
Loading

📝 Walkthrough

Walkthrough

The changes in the .github/workflows/e2e.yml file involve updates to job execution conditions and workflow event handling. The conditional statements for the matrix-conditionals, e2e, and e2e-ok jobs have been revised to prevent execution when workflows are cancelled. Additionally, the matrix-conditionals job has been improved for better clarity in determining which tests to run based on the triggering event context, while maintaining the logic for setting outputs based on various GitHub events.

Changes

File Change Summary
.github/workflows/e2e.yml Updated job conditions from if: always() to if: ${{ !cancelled() }}; enhanced logic for determining tests based on event context while retaining existing output setting logic.

Possibly related PRs

Suggested reviewers

  • lumtis
  • morde08

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the ci Changes to CI pipeline or github actions label Nov 27, 2024
@gartnera gartnera marked this pull request as ready for review November 27, 2024 20:47
@gartnera gartnera requested a review from a team as a code owner November 27, 2024 20:47
@gartnera gartnera enabled auto-merge November 27, 2024 20:47
coderabbitai[bot]
coderabbitai bot reviewed Nov 27, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
.github/workflows/e2e.yml (1)

Line range hint 107-284: Consider documenting the cancellation behavior

While the changes are correct, it would be beneficial to add a comment explaining the cancellation behavior for future maintainers.

Add a comment above each job:

+  # Skip execution if the workflow was cancelled
   if: ${{ !cancelled() }}
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 08ff881 and 1704b25.

📒 Files selected for processing (1)
  • .github/workflows/e2e.yml (3 hunks)
🔇 Additional comments (2)
.github/workflows/e2e.yml (2)

220-220: LGTM: Enhanced e2e job execution control

The condition change improves resource utilization by preventing unnecessary test execution when the workflow is cancelled.

284-284: LGTM: Refined e2e-ok job condition

The modification ensures proper handling of the final status check job, maintaining consistency with the upstream jobs' behavior.

.github/workflows/e2e.yml Show resolved Hide resolved
@gartnera gartnera added this pull request to the merge queue Dec 2, 2024
Merged via the queue into develop with commit 85899e5 Dec 2, 2024
43 checks passed
@gartnera gartnera deleted the e2e-notcancelled branch December 2, 2024 16:57
@coderabbitai coderabbitai bot mentioned this pull request Dec 10, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@CryptoFewka CryptoFewka CryptoFewka approved these changes

@lumtis lumtis lumtis approved these changes

Assignees
No one assigned
Labels
ci Changes to CI pipeline or github actions no-changelog Skip changelog CI check
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@gartnera @lumtis @CryptoFewka